SearchFilter Json Schema

In This Topic

Description

The Search Filter provides the options to filter search results by product code or program name. This is useful if you know you are looking for a specific program or product.

Leaving both productCode and programNames fields blank returns all applicable results.

Example:

Filter results for the Fannie Mae 30-Year Fixed and Home Possible 30 Year Fixed programs that contain the product code "Conforming":

"filter":{

"productCode":["Conforming"],

"programNames":["Home Possible 30 Year Fixed", "Fannie Mae 30-Year Fixed"]

}

Overview

SearchFilter

The Search Filter provides the options to filter search results by product code or program name. This is useful if you know you are looking for a specific program or product.

Leaving both productCode and programNames fields blank returns all applicable results.

Example:

Filter results for the Fannie Mae 30-Year Fixed and Home Possible 30 Year Fixed programs that contain the product code "Conforming":

"filter":{

"productCode":["Conforming"],

"programNames":["Home Possible 30 Year Fixed", "Fannie Mae 30-Year Fixed"]

}

getRateGridFilterReason : boolean

ineligibleProduct : boolean

priceIneligibleProduct : boolean

productCode : Array[string]

This field is used to filter results for specific product codes. The product code(s) entered must be an exact match with those in the data.

This filter will return all programs that have any of the product codes associated with them.

Example:

"productCode": ["HomeReady"]

programNames : Array[string]

This field is used to filter results for specific program names. The program name(s) entered must be an exact match with those in the data.

This filter will return only the programs passed in the array.

Example:

"programName": ["Fannie Mae 30 Year Fixed"]

rateFilter : RateFilter

condition : string

filters : Array[RateFilterItem]

op : string

type : string

value : string

Properties

Name	Description	Data Type
getRateGridFilterReason		boolean
ineligibleProduct		boolean
priceIneligibleProduct		boolean
productCode	This field is used to filter results for specific product codes. The product code(s) entered must be an exact match with those in the data. This filter will return all programs that have any of the product codes associated with them. Example: `"productCode": ["HomeReady"]`	Array[string]
programNames	This field is used to filter results for specific program names. The program name(s) entered must be an exact match with those in the data. This filter will return only the programs passed in the array. Example: `"programName": ["Fannie Mae 30 Year Fixed"]`	Array[string]
rateFilter		RateFilter